Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve incomfort docs #36949

Merged
merged 6 commits into from
Jan 16, 2025
Merged

Improve incomfort docs #36949

merged 6 commits into from
Jan 16, 2025

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Jan 16, 2025

Proposed change

Provide a better description about the Incomfort LAN2RF gateway and how it is supported.
Instructions on how to remove the integration were added.

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Enhanced documentation for the Incomfort integration.
    • Added details about Intergas Lan2RF Gateway compatibility with OpenTherm thermostats.
    • Clarified supported appliance models and Comfort Touch thermostat functionality.
    • Included new section on standard integration removal process.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Jan 16, 2025
Copy link

netlify bot commented Jan 16, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 1c20812
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6788c4a176024700082d8c8c
😎 Deploy Preview https://deploy-preview-36949--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

coderabbitai bot commented Jan 16, 2025

Warning

Rate limit exceeded

@c0ffeeca7 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 26 minutes and 13 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 903278e and 1c20812.

📒 Files selected for processing (1)
  • source/_integrations/incomfort.markdown (2 hunks)
📝 Walkthrough

Walkthrough

The pull request updates the documentation for the incomfort integration in Home Assistant. The changes focus on improving the clarity and comprehensiveness of the documentation by adding more detailed explanations about the Intergas Lan2RF Gateway, supported thermostat models, and integration functionality. The documentation now provides clearer information about device compatibility, temperature control, and the integration removal process.

Changes

File Change Summary
source/_integrations/incomfort.markdown - Added specification about using the incomfort client library
- Expanded description of Intergas Lan2RF Gateway compatibility
- Clarified supported Intergas appliance models
- Updated room thermostat functionality description
- Added new "Remove integration" section

No sequence diagram is necessary for this documentation update, as the changes are primarily textual and do not involve changes to system interactions or control flow.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a586302 and 53ab135.

📒 Files selected for processing (1)
  • source/_integrations/incomfort.markdown (2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/incomfort.markdown

[grammar] ~38-~38: This phrase is duplicated. You should probably use “changing the” only once.
Context: ...erature can be changed. This similar to changing the changing the target temperature override using the C...

(PHRASE_REPETITION)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (2)
source/_integrations/incomfort.markdown (2)

24-24: LGTM! Good addition of the library reference.

Adding the link to the underlying client library provides valuable context for users and developers.


44-49: LGTM! Clear and standard-compliant removal instructions.

The new section follows Home Assistant documentation standards and properly includes the standard device removal template.

source/_integrations/incomfort.markdown Outdated Show resolved Hide resolved

It uses the [incomfort](https://pypi.org/project/incomfort-client/) client library.
The Intergas Lan2RF Gateway connects thermostats based on the OpenTherm standard like the [https://www.intergas-verwarming.nl/en/consumer/products/comfort-touch-thermostat/](Comfort Touch Thermostat). The thermostats and LAN2RF gateway are often sold as a set. The gateway is suitable for use with Intergas Kombi Kompakt HRE and HReco appliances from year of manufacture 2014. If the Comfort Touch thermostat together with the gateway, then this will work in combination with Intergas Kombi Kompakt HRE, HReco or Xtreme devices from year of manufacture 2017.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix the markdown link syntax.

The link to the Comfort Touch Thermostat is using incorrect markdown syntax.

Apply this correction:

-[https://www.intergas-verwarming.nl/en/consumer/products/comfort-touch-thermostat/](Comfort Touch Thermostat)
+[Comfort Touch Thermostat](https://www.intergas-verwarming.nl/en/consumer/products/comfort-touch-thermostat/)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
The Intergas Lan2RF Gateway connects thermostats based on the OpenTherm standard like the [https://www.intergas-verwarming.nl/en/consumer/products/comfort-touch-thermostat/](Comfort Touch Thermostat). The thermostats and LAN2RF gateway are often sold as a set. The gateway is suitable for use with Intergas Kombi Kompakt HRE and HReco appliances from year of manufacture 2014. If the Comfort Touch thermostat together with the gateway, then this will work in combination with Intergas Kombi Kompakt HRE, HReco or Xtreme devices from year of manufacture 2017.
The Intergas Lan2RF Gateway connects thermostats based on the OpenTherm standard like the [Comfort Touch Thermostat](https://www.intergas-verwarming.nl/en/consumer/products/comfort-touch-thermostat/). The thermostats and LAN2RF gateway are often sold as a set. The gateway is suitable for use with Intergas Kombi Kompakt HRE and HReco appliances from year of manufacture 2014. If the Comfort Touch thermostat together with the gateway, then this will work in combination with Intergas Kombi Kompakt HRE, HReco or Xtreme devices from year of manufacture 2017.

c0ffeeca7 and others added 2 commits January 16, 2025 08:23
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @jbouwh 👍

@c0ffeeca7 c0ffeeca7 merged commit 340bbec into current Jan 16, 2025
8 of 9 checks passed
@c0ffeeca7 c0ffeeca7 deleted the incomfort-docs-improvement branch January 16, 2025 08:35
@github-actions github-actions bot locked and limited conversation to collaborators Jan 17, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
by-code-owner current This PR goes into the current branch integration: incomfort
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants